Request Number Status Validation

The Request Number Status Validation request validates the status of the uploaded numbers.

URL

Copy

{{baseUrl}}/api/v2/oc/numbers/action/number-status

HTTP Method

POST

Request Body

Parameter

Type

Description

telephoneNumbers

string list

List of phone numbers that are uploaded to the customer.

Phone number validation rules are in accordance with E.164 format:

■

A + sign.

■

Country calling code (international).

■

Local area code.

Local telephone number or subscriber number.

It has the following structure: [+][country code][area code][subscriber number].

Example of a number with E.164 format in the United States

Telephone number: 415 123 1234

E.164 format number: +14151231234

■

Country code: +1

■

Area code: 415

■

Subscriber number: 1231234

Valid country code, per civic address and/or contact info of the given lead. See Country Dialing Codes.

msTenantId

string

Microsoft Tenant ID of customer tenant for validation.

Example Request-Single Number

Copy

     {
  "telephoneNumbers": [
    "+18333998785"
  ],
  "msTenantId": "f94238e5-4f2c-4e1b-8125-2d27122ca75f"
}

HTTP Responses

■

200 OK

Parameter

Type

Description

validationResult

string

Indicates if the validation execution is successful.

■

Success: The number is successfully validated.

■

Failure: The number cannot be validated. This response also reflects scenarios where the number is currently being processed (the number is still in cache memory due to Upload or Release action).

telephoneNumbers

list array

List array including the following values:

telephoneNumber; validationResult, actionRequired, validationDetail, telephoneNumberDetail: numberFound, numberOffering and assignmentStatus

telephoneNumber

string

Indicates the telephone number that was validated.

validationResult

string

Indicates if the validation execution succeeded or failed.

actionRequired

string

Indicates if any actions are required.

validationDetail

dictionary

Dictionary including the following:

■

Level

■

Description

Level

string

Error or Information message

Description

string

Description of the message (see examples below)

telephoneNumberDetail

dictionary

Dictionary including the following:

■

numberFound

■

numberOffering

■

assignmentStatus

numberFound

boolean

Indicates whether the number is found in the Customer inventory in the Live Platform database.

■

True: The number is found in the Customer inventory. This response also reflects scenarios where the number is currently being processed (is in cache memory due to Upload or Release of number).

■

False: The number is

numberOffering

string

One of the following values:

■

Operator Connect

■

Direct Routing

■

Microsoft Calling Plan

assignmentStatus

boolean

Indicates whether the number has been assigned to the subscriber user in their Teams admin center.

■

400 Bad Request

Parameter	Type	Description/Examples
errors	string	Text description of the error.
type	string	"https://tools.ietf.org/html/rfc7231#section-6.5.1"
title	string	Email title. For example "One or more validation errors occurred."
status	error code	HTML error code i.e. 400
detail	string	Additional error details.
traceId	string	Error trace Id
instance	string	Error instance
errorTicket	string	This field may not appear for all return codes.
errorCode	string	This field may not appear for all return codes.
additionalProp1	string	Custom Script variable argument. For example "CacProfile": "5 sessions"
additionalProp2	string	Custom Script argument. For example, ProxySet": "SIPTrunk"
additionalProp3	string	Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"

■

403 Forbidden

■

500 Internal Server Error